<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
<meta content="Docs,com.digitalflipbook.webapis.scribd.methodgroups.Docs,changeSettings,deleteDoc,getConversionStatus,getList,getSettings,search,upload,uploadFromUrl" name="keywords">
<title>com.digitalflipbook.webapis.scribd.methodgroups.Docs</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'Docs - DigitalFlipbook ActionScript 3.0 Library - as3scribdlib';
				var baseRef = '../../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../index.html?com/digitalflipbook/webapis/scribd/methodgroups/Docs.html&amp;com/digitalflipbook/webapis/scribd/methodgroups/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;Docs</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Docs"); titleBar_setSubNav(false,false,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.digitalflipbook.webapis.scribd.methodgroups</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Docs</td>
</tr>
</table>
<p></p>
<p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#Docs()">Docs</a>(service:<a href="../ScribdService.html">ScribdService</a>)</div>
<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#changeSettings()">changeSettings</a>(doc_ids:String, title:String = null, description:String = null, access:String, license:String, show_ads:String, tags:String = null):void</div>
<div class="summaryTableDescription">
   This method updates the meta-data for existing documents.</div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#deleteDoc()">deleteDoc</a>(doc_id:String):void</div>
<div class="summaryTableDescription">
   This method deletes an existing document.</div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getConversionStatus()">getConversionStatus</a>(doc_id:String):void</div>
<div class="summaryTableDescription">
   This method retrieves the conversion status of the document.</div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getList()">getList</a>():void</div>
<div class="summaryTableDescription">
   This method retrieves a list of documents for a given user.</div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getSettings()">getSettings</a>(doc_id:String):void</div>
<div class="summaryTableDescription">
   This method retrieves the meta-data for existing documents.</div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#search()">search</a>(query:String, num_results:int = 10, num_start:int = 1, scope:String = "user"):void</div>
<div class="summaryTableDescription">
   This method searches for the specified query within the scribd documents.</div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#upload()">upload</a>(file:FileReference, doc_type:String = null, access:String, rev_id:int = 0):void</div>
<div class="summaryTableDescription">
   This method accepts the document file via Multi-Part POST.</div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#uploadFromUrl()">uploadFromUrl</a>(url:String, doc_type:String = null, access:String, rev_id:int = 0):void</div>
<div class="summaryTableDescription">
   This method retrieves the document file from the specified URL.</div>
</td><td class="summaryTableOwnerCol">Docs</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:changeSettings">changeSettings</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the changeSettings method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_changeSettings_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:delete">delete</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the delete method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_delete_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:getConversionStatus">getConversionStatus</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the getConversionStatus method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_getConversionStatus_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:getList">getList</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the getList method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_getList_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:getSettings">getSettings</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the getSettings method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_getSettings_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:search">search</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the search method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_search_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:upload">upload</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the upload method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_upload_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">Docs</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:uploadFromUrl">uploadFromUrl</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the uploadFromUrl method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_uploadFromUrl_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">Docs</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="Docs()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">Docs</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function Docs(service:<a href="../ScribdService.html">ScribdService</a>)</code><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">service</span>:<a href="../ScribdService.html">ScribdService</a></code></td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="changeSettings()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">changeSettings</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function changeSettings(doc_ids:String, title:String = null, description:String = null, access:String, license:String, show_ads:String, tags:String = null):void</code><p>
   This method updates the meta-data for existing documents.
   Only send arguments for fields you would like to overwrite.
   Will return a blank response object if succesful.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">doc_ids</span>:String</code> &mdash; A list of document IDs corresponding to documents to be updated.
       You can of course pass just one document ID here, in which case it will do a single update.
       But you can also pass a comma-separated list (no spaces) to do a bulk update.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">title</span>:String</code> (default = <code>null</code>)<code></code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">description</span>:String</code> (default = <code>null</code>)<code></code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">access</span>:String</code> &mdash; Default: "public".
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">license</span>:String</code> &mdash; Default: "by-nc". See Wikipedia:Creative_Commons_License. "c" is traditional copyright. "pd" is public domain.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">show_ads</span>:String</code> &mdash; This determines whether ads will be shown on this document.
       A "default" setting means that whether to show ads or not is being determined by global account settings accessible from your account page.
       Unless you want to show ads on only some documents, it is easiest to control this setting from your account page.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">tags</span>:String</code> (default = <code>null</code>)<code></code> &mdash; Tags cannot contain whitespace.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=docs.changeSettings" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=docs.changeSettings</a>
</div>
</div>
<a name="deleteDoc()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">deleteDoc</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function deleteDoc(doc_id:String):void</code><p>
   This method deletes an existing document.
   Will return a blank response object if succesful.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">doc_id</span>:String</code> &mdash; The document ID corresponding to the document to be deleted.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=docs.delete" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=docs.delete</a>
</div>
</div>
<a name="getConversionStatus()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getConversionStatus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getConversionStatus(doc_id:String):void</code><p>
   This method retrieves the conversion status of the document.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">doc_id</span>:String</code> &mdash; The document ID corresponding to the document to retrieve the conversion status on.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=docs.getConversionStatus" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=docs.getConversionStatus</a>
</div>
</div>
<a name="getList()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getList():void</code><p>
   This method retrieves a list of documents for a given user.
   
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=docs.getList" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=docs.getList</a>
</div>
</div>
<a name="getSettings()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getSettings</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getSettings(doc_id:String):void</code><p>
   This method retrieves the meta-data for existing documents.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">doc_id</span>:String</code> &mdash; The document ID corresponding to the document to retrieve the settings on.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=docs.getSettings" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=docs.getSettings</a>
</div>
</div>
<a name="search()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">search</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function search(query:String, num_results:int = 10, num_start:int = 1, scope:String = "user"):void</code><p>
   This method searches for the specified query within the scribd documents.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">query</span>:String</code> &mdash; Number of results to return: Default 10, max 1000.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">num_results</span>:int</code> (default = <code>10</code>)<code></code> &mdash; Number to start at: Default 1. Cannot exceed 1000.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">num_start</span>:int</code> (default = <code>1</code>)<code></code> &mdash; Whether to search all of scribd OR just within one user/'s documents.
       If scope is set to "user" and session_key is not provided, the documents uploaded by the API user will be searched.
       If scope is set to "user" and session_key is given, the documents uploaded by the session user will be searched.
       If scope is "all", only public documents will be searched. Set to "user" by default.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">scope</span>:String</code> (default = "<code>user</code>")<code></code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=docs.search" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=docs.search</a>
</div>
</div>
<a name="upload()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">upload</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function upload(file:FileReference, doc_type:String = null, access:String, rev_id:int = 0):void</code><p>
   This method accepts the document file via Multi-Part POST.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">file</span>:FileReference</code> &mdash; The contents of the file to upload. This needs to be expressed as part of a multi-part HTTP POST.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">doc_type</span>:String</code> (default = <code>null</code>)<code></code> &mdash; Identify the document type with what the extension ouldbe for this file. "pdf", "doc", "txt", "ppt", etc.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">access</span>:String</code> &mdash; Default: "public".
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">rev_id</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The doc_id to save uploaded file as a revision.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=docs.upload" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=docs.upload</a>
</div>
</div>
<a name="uploadFromUrl()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">uploadFromUrl</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function uploadFromUrl(url:String, doc_type:String = null, access:String, rev_id:int = 0):void</code><p>
   This method retrieves the document file from the specified URL.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">url</span>:String</code> &mdash; The url of the file to upload.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">doc_type</span>:String</code> (default = <code>null</code>)<code></code> &mdash; Identify the document type with what the extension ouldbe for this file. "pdf", "doc", "txt", "ppt", etc.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">access</span>:String</code> &mdash; Default: "public".
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">rev_id</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The doc_id to save uploaded file as a revision.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=docs.uploadFromUrl" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=docs.uploadFromUrl</a>
</div>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:changeSettings"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">changeSettings</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.DOCS_CHANGE_SETTINGS</code></a>
<br>
<p></p><p>
  Broadcast as a result of the changeSettings method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_changeSettings_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/Docs.html#changeSettings" target="">changeSettings</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<a name="event:delete"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">delete</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.DOCS_DELETE</code></a>
<br>
<p></p><p>
  Broadcast as a result of the delete method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_delete_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/Docs.html#delete" target="">delete</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<a name="event:getConversionStatus"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getConversionStatus</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.DOCS_GET_CONVERSION_STATUS</code></a>
<br>
<p></p><p>
  Broadcast as a result of the getConversionStatus method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_getConversionStatus_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/Docs.html#getConversionStatus" target="">getConversionStatus</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<a name="event:getList"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getList</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.DOCS_GET_LIST</code></a>
<br>
<p></p><p>
  Broadcast as a result of the getList method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_getList_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/Docs.html#getList" target="">getList</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<a name="event:getSettings"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getSettings</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.DOCS_GET_SETTINGS</code></a>
<br>
<p></p><p>
  Broadcast as a result of the getSettings method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_getSettings_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/Docs.html#getSettings" target="">getSettings</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<a name="event:search"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">search</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.DOCS_SEARCH</code></a>
<br>
<p></p><p>
  Broadcast as a result of the search method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_search_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/Docs.html#search" target="">search</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<a name="event:upload"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">upload</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.DOCS_UPLOAD</code></a>
<br>
<p></p><p>
  Broadcast as a result of the upload method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_upload_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/Docs.html#upload" target="">upload</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<a name="event:uploadFromUrl"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">uploadFromUrl</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.DOCS_UPLOAD_FROM_URL</code></a>
<br>
<p></p><p>
  Broadcast as a result of the uploadFromUrl method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "docs_uploadFromUrl_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/Docs.html#uploadFromUrl" target="">uploadFromUrl</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
